Definition Editor

Used to create, save, rename, and delete user defined DataGroup definitions.

Accessed from:

Backstage: File > Dataset Tools > Definition Editor
Catalog Editor:Show Definition Usage mode: right-click > Definition Editor...

About DataGroup definitions

DataGroup definitions (at times referred to as a schema) are employed to help you use and customize a system of data to facilitate the creation of standard and custom parametric catalogs and catalog item properties, values and attributes. The system also enables instance data to be assigned to individual catalog items when placement tools and commands are used and to manage and track data for many uses including reports and schedules.

Generally a DataGroup definition is a catalog (a set of many data definitions) where one definition applies to each catalog item (e.g. door and window). Individual catalog item definitions define each item attribute (e.g. door fire rating) by name and format.

In Definition Editor, some definitions and properties are used by OpenBuildings Station Designer tools and utilities. These definitions can not be modified except for their display names. They are displayed with grey text. The dialog's tools and right-click options are disabled when selecting application referenced definitions and properties.

Definition Editor toolbar

Setting	Description
New Definition File	Opens the New Definition File dialog. It is here where new element/attribute names and destination directory file locations are established. Destination - Sets the location of the new definition file (.xsd). Organization - Sets the location to the configured organization level location. Workspace - Sets the location to the configured workspace (user group) level location. Workset - Sets the location to the configured workset (project) level location. Note: In case of COBie template, you will notice additional options Dataset Extension: IFC and Dataset Extension: FM_Handover_Ext can be set as destination. File name - Used to name the new definition file (.xsd). Display name - Used to enter the definition name to be displayed in the applicable dialogs. Note: While creating new definition files, the Destination location can be set beforehand. This decides the access level of control over the dataset. The new definition file can be located in one of the predefined Destination locations. Unlike display name, the file name should not have spaces but can have only letters, numbers, dash, underscore and period characters. Also. avoid adding any dot character in display name.
New Property Group	Inserts a new property group in the directory list box at the active directory location. The default name for new property is `NewPropertyGroup`. You can rename it by selecting right-click > Rename.
New Property	Inserts a new property in the directory list box at the active directory location. The default name for new property is `NewProperty`. You can rename it by selecting right-click > Rename.
Validate	Opens the DataGroup System Validator where you can validate the dataset and view the status of individual validated items.
Save	Saves new element and attribute DataGroup definitions (new property and property group definitions).

Definitions tree (left panel)

Displays definitions, definition catalogs, catalog items, and item instances. Used to navigate to and select definition properties and property groups. Selections determine the information displayed in the adjacent list box.

Setting	Description
Definitions node	When the root node is selected, it lists all the definitions available in the active dataset. The right-click options: New Definition File - Opens the New Definition File dialog. Export Definitions CSV - Exports all definitions to an Excel file (.csv). The .csv file automatically opened in Excel and lists definition name, display name and the .xsd file path for each definition. An information dialog titled "Export Definitions CSV" appears and displays the number of exported definitions and the .csv file path. Export Definition Properties CSV - Exports all definitions and their properties to an Excel file (.csv). The .csv file automatically opened in Excel and lists all definitions and their properties hierarchically; name and display name are displayed for each definition/property, and the .xsd file path is displayed for each defition. An information dialog titled "Export Definition Properties CSV" appears and displays the number of exported definitions and the .csv file path. Note: Exported *.csv files are maintained in a default location (the active worksets ..\\Output folder). This Excel data can be used offline to review the definitions and display names and revise them in Definition Editor, as required.
Definition nodes	When selected, lists all the property groups and properties in the definition. The right-click options: New Definition File - Opens the New Definition File dialog. New Property Group - Inserts a new property group in the definitions tree at the active location. New Property - Inserts a new property in the definitions tree at the active location. Properties - Opens the Properties dialog where definition information is available for selected definition/property group. Only the Display name can be modified in the Properties dialog.
Property Group node	Used to create hierarchies or groups of definition properties. Like definition file nodes, selecting property group nodes lists definition properties and property groups, and displays the same column data. Additional right-click options: Rename - Renames selected definition property or property group. Select the directory item to activate an editor field. Delete - Deletes selected definition property/property group after confirming. Deleting a property group removes all properties it contains.
Property node	When selected, lists all definition properties and their values. Right click options include all those mentioned here except the Properties menu option.

Properties list box (right panel)

Definitions, definition groups and values are displayed, created and edited in this list box. Information in columns and rows can be modified by selecting the applicable cell to activate an editor field, a drop menu option, or a pop-up dialog. Columns can be sorted by clicking in the column heading.

For instance, setting Default value for the Data type Structural Section is done with the Structural Sections chooser dialog which opens when clicking in the Value field.

Example of Default Value's settings

Note: Secondary dialogs are specific to Definition Editor and are opened outside of OpenBuildings Station Designer. They function similar to their equivalent dialogs in OpenBuildings Station Designer.

Setting	Description
Definitions display	When the Definitions node is selected in the Definitions tree, the following columns are displayed: Display name - The name which is displayed in DataGroup data tools and utilities. Name - The name given to the definition. Path - Lists the definitions (.xsd) file locations. Note: Only Display name is editable (click in the Display name field).
Definition & Definition Group display	Properties common to all definitions are listed in columns when Definition or Property Group nodes are selected from the Definitions tree. These common properties are also listed as rows when properties are selected from the Definitions tree. They appear whenever you create a new property. Name - The name given to the property or property group. Display name - The name which is displayed in DataGroup data tools and utilities. Data type - Defines how the property value is entered for the property. Default value - A set value for the property when a catalog item using the definition property is initialized upon placement/modification. Required - "On" indicates the definition property must be defined with a value upon placement/modification.
Property display	When a Property node is selected in the Definitions tree, the following columns are displayed: Property - Lists all the definition properties. The list varies depending upon which Data type is selected. Properties which are common to all definitions are listed when selecting definition file or property group nodes. Value - Lists defined values of all the listed definition properties. Values are editable by clicking in the value fields.
Status Bar	Displays the status of current items being loaded. Also, displays the description of the task being selected on the toolbar or in right-click options.

List box controls

The following Properties list box controls are used to define and organize definitions and properties. The effects of customizing your datasets can then be seen in tools and utilities that reference the definitions.

Setting

Description

Data Type & Default Value

The property Data Type defines how property values are entered for the property. Depending on the data type selected, displayed properties vary. For example, selecting the Decimal data type lists an additional Fraction digits property. For every selected data type you can set Default value by clicking in the next property field. Refer to the following table for Data type and Default value/Value input options as well as additional properties (added by data type selections).

Data type	Dataset example (`Property group name` - Tool name > Property display name )	Value input	Additional properties
Area Units	`ArchSpace` - Space > Area \| Program (sq ft)	Entered values are processed as "square units".	Pattern
Boolean	`ArchDoor` - Door > Frame/Dimension \| Frame Depth	Matches parent wall thickness with "Yes/No" value via check box.	none
Cell	`Profile_Common` - Profile > Cell Symbol Name	Value is set with the Cells dialog (opens when clicking in the property value field).	none
Classification	`SpaceEnergyAnalysis` - Space > Energy Analysis \| Space Type	Value is set with the Classification system pop up dialog.	System Type
Date	none	Values (dates) are set by selecting from a Calendar pop up dialog.	none
Decimal	`CustomParamBMPElbow` - Duct Accessory > Standard Angle	Typically used for dimensional properties. Value is set by entering a decimal value in the text field.	Unit Fraction digits Minimum value Maximum value Pattern
Integer	`StairConstraints` - Place Stair > Riser Number Maximum	Only integer values are processed.	Minimum value Maximum value Pattern
list	`StructuralFramingCommon` - Beams > Structural Finish	Value is set by selecting from a drop menu containing a defined set of options.	Extendable List Values
Logical	none	Values true, false and unknown are set by selecting from a drop menu.	none
Part	Fireproofing Type - Part Defition	Value is set with the Part and Family Chooser dialog (opens when clicking in the property value field).	none
String	`ObjectIdentity` - Wall > ID \| Notes	Value can be any text string, and is entered into the text field.	Minimum length Maximum length Pattern
Structural Section	`StructuralFramingCommon` - Beams > Section Name	Value is set with the Structural Section dialog (opens when clicking in the property value field).	none
URL	`ObjectManufacturer` - Curtain Wall > Manufacture \| URL	Values are selected from a drop down menu.	Pattern
Volume Units	`SlabQuantities` - Schedules > Volume (Net)	Values are displayed as "cubic units".
Working Units	`Penetration` - Opening > Dimension \| Length	Entered values are processed in the active working units.

Cells

For the Cell data type, default values are set in the Cells dialog. It opens when you click in the Default value field. Use the Cell Library drop down menu to select a cell library from which to select a cell.

Classifications

For the Classification data type, default values are set in the Classifications dialog. It opens when you click in the Default value field. The Classification data type adds the System Type property which you set by selecting a classification system from a drop down menu. This selection populates the Classifications dialog with available Building classifications. Use the Search field to refine the classifications listing.

Define Order

Selecting Right-click > Define Order on items in the properties list box (when a Definition File node is selected from the Definitions list) opens the Order dialog. This dialog is used to define the sort order of properties in a definition.

Property panel - Lists the catalog item properties categorized in the property groups to which they belong. Clicking on the a category selects all the properties within. You can also select individual properties. Both active the move up/down arrow buttons.
Move Up/Down arrows - Enabled when selections are made in the Property panel.
- - Moves selected properties up to the topmost level while keeping the selected properties order the same.
- - Moves selected properties one level up.
- - Moves selected properties one level down.
- - Moves selected properties down to the lowest level while keeping the selected properties order the same.
A-Z - Orders the entire list of properties alphabetically. Property groups are ordered first, followed by properties within.
OK - Saves changes and closes the dialog.
Cancel - Cancels changes and closes the dialog.

Note: Changes made are saved to the definition file (*.xsd), and can be seen in Building tools which access the definition.

List Values

For the List data type, lists of values are created in the Property list box which then populate the property value drop down menu. Selecting the List data type enables the List Values settings. You can then select an item from the list to set Default value ([None] is provided as the default value).

(New List Item) - Opens a text field in which to enter the list items. Pressing <Enter> adds a new list item row.
(Delete List Item) - Deletes selected list items.

Note: Select an item from the list to set Default value ([None] is provided as the default value).

Part and Family Chooser

For the Part data type, default values are set in the Part and Family Chooser dialog. It opens when you click in the Default value field. Use the Family and Part drop down menus to select a part definition.

Pattern property (String)

For the String data type, the Pattern property is used to set a text string pattern that defines how a property value must be entered for any applicable catalog types and items.

For example when a catalog item has a property called "Zip Code" (for which data such as 19341-1127 is entered) the following actions are completed:

The Data Type property value is set to String.
The Pattern property value is set to [0-9]{5}-[0-9]{4}.

This string designates that the pattern property value must be entered as two sets of characters, one set of five characters and one set of four characters respectively. Each set of characters must be composed of integers 0 through 9 and the two character sets must be separated by a dash.

This expression is further defined as follows:

Property Value	Description
[0-9]	Only integers 0 though 9 can be used in the character set.
{5}-	This set is composed of 5 characters followed by a dash.
[0-9]	Only integers 0 though 9 can be used in the character set.
{4}	This set is composed of 4 characters.

Entering a value that does not comply with the designated format results in a default value defined by the catalog, or a reentry of the last valid value used.

When a text string pattern is set in the Definition Editor, values for the pattern can be entered in the Catalog Editor and in any catalog property panel employed in the application.

Note: Refer to Microsoft XML documentation regarding Pattern Element for more information.

Structural Section

For the Structural Section data type, default values are set in the Structural Sections Chooser dialog (see the above "Example of Default Value's settings" illustration). It opens when you click in the Default value field. Use the Browse [...] button to select and load the Structural Section file and narrow down the selection by choosing desired Code and Type.

Preferred Units

Used to define the Unit property for Decimal data type properties. Clicking in the Unit value field opens the Preferred Units dialog where you can choose from a list of units. The selection made here sets the unit display for all tools and utilities which access the property's definition.

Key-in: DG DEFEDITOR